iHabitat.FilterOnType


Filter out habitats which do not match a given habitat type.

prototype set iHabitat.FilterOnType( set habitats,
                                     IeHabitatType type );

Parameters:
habitats : The set of habitats to filter.
type : The habitat type to filter on.

Return value:
Returns a set of those habitats from the given set which match the given type.

See also:
iMapEntity.SystemHabitats, iHabitat.Type, iHabitat.IeHabitatType.